/*
 * Copyright 2009 Gary Brown
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 *
 * Change History:
 * 7 Mar 2009 : Initial version created by gary
 */
package org.betonthemove.platform;

/**
 * This interface represents a bet that has been placed with the
 * betting platform.
 *
 */
public interface Bet {

	/**
	 * This method determines whether the bet is a 'back' type.
	 * If this method returns false, then the bet represents a
	 * 'lay'.
	 * 
	 * @return Whether the bet is a 'back'
	 */
	public boolean isBack();
	
	/**
	 * This method determines whether the bet is matched.
	 * 
	 * @return Whether the bet is 'matched'
	 */
	public boolean isMatched();
	
	/**
	 * This method returns the odds associated with the bet.
	 * 
	 * @return The odds
	 */
	public double getOdds();
	
	/**
	 * This method returns the amount placed on this bet.
	 * 
	 * @return The amount
	 */
	public double getStake();
	
	/**
	 * This method returns the market id associated with the bet.
	 * 
	 * @return The market id
	 */
	public int getMarketId();
	
	/**
	 * This method returns the market name.
	 * 
	 * @return The market name
	 */
	public String getMarketName();
	
	/**
	 * This method returns the entrant id associated with the bet.
	 * 
	 * @return The entrant id
	 */
	public int getEntrantId();
	
	/**
	 * This method returns the entrant name.
	 * 
	 * @return The entrant name
	 */
	public String getEntrantName();
	
	/**
	 * This method returns the id associated with the bet.
	 * 
	 * @return The bet id
	 */
	public long getBetId();
}
